Transforms forRWProjectBrowserTabBean


ObjectBrowserTabOMDTransform

Formal Parameter Type Default Required Description
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
applyJS STRING   false Indicates JavaScript functionality to be invoked when 'Apply' buttons is pressed.
applyLabel STRING   false Indicates the apply label when no title id is provided.
applyLabelID STRING mstrWeb.134 false Indicates the apply label id according to the application's resource buldles.
attributeFormImage STRING formli.png false Indicates the image to use when displaying an attribute form.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
attributeImage STRING Attribute.png false Indicates the image to use when displaying an attribute.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
canAutoSize BOOLEAN false false Indicates if editor should auto-size to show the contents.
cancelJS STRING   false Indicates JavaScript functionality to be invoked when 'Cancel' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
cancelLabel STRING   false Indicates the cancel label when no title id is provided.
cancelLabelID STRING mstrWeb.2140 false Indicates the cancel label id according to the application's resource buldles.
closeJS STRING   false Indicates JavaScript functionality to be invoked when 'Close' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
consolidationImage STRING consolidation.png false Indicates the image to use when displaying a consolidation.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
createForm BOOLEAN true false  
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
cubeImage STRING lsCube.gif false Indicates the image to use when displaying a cube.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
customGroupImage STRING customGroup.png false Indicates the image to use when displaying a custom group.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
derivedMetricImage STRING DerivedMetric.png false Indicates the image to use when displaying a derived metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
dhtmlClose BOOLEAN true false Indicates if the close action will be executed using dhtml.
disableOKButton BOOLEAN false false Indicates whether to disable the OK button
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    editorContentsStyle STRING   false Indicates the style name to be used for the div containing the editor contents
    editorElements INTEGER 127 false Indicates the elements to display by the editor. The flags are taken from the EnumEditorDisplayFlags enumeration.
    editorLayoutFile STRING   false Indicates the name of the definition file associated with the editor.
    editorSubType STRING   false Indicates the subtype to be used for the STY attribute for the editor container
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    filterImage STRING Filter.gif false Indicates the image to use when displaying a filter.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    folderImage STRING folder2.gif false Indicates the image to use when displaying a folder.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    folderJS STRING return omd.anchorToForm(this) false  
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    graphImage STRING report2.gif false Indicates the image to use when displaying a graph.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    gridGraphImage STRING report2.gif false Indicates the image to use when displaying a grid and graph.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    helpPage STRING   false Indicates the sub-page for the help for the editor.
    helpTopic STRING   false Indicates the help topic for the help page of the editor.
    helpType STRING user false Indicates the type of help topic this editor uses.
    hierarchyImage STRING hierarchy.png false Indicates the image to use when displaying a hierarchy.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgFirstPage STRING arrow_first_inc_fetch.gif false  
    imgFirstPageDisabled STRING arrow_first_inc_fetch_disabled.gif false  
    imgLastPage STRING arrow_end_inc_fetch.gif false  
    imgLastPageDisabled STRING arrow_end_inc_fetch_disabled.gif false  
    imgNextPage STRING arrow_right_inc_fetch.gif false  
    imgNextPageDisabled STRING arrow_right_inc_fetch_disabled.gif false  
    imgPreviousPage STRING arrow_left_inc_fetch.gif false  
    imgPreviousPageDisabled STRING arrow_left_inc_fetch_disabled.gif false  
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    includeDynamicScript BOOLEAN true false Indicates whether dynamic scripts will be included while rendering the page.
    Usage:
    This is a Boolean formal parameter, where true indicates that the dynamic javascripts will be included, false otherwise.
    incrementalFetchJS STRING return omd.anchorToForm(this) false  
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    levelChangeJS STRING processSelect(this) false  
    levelFlag INTEGER -1 false This level flag can be used to control the components that will be rendered by the project browser bean. The default value of the level flag is ObjectBrowserTabOMDTransform.DISPLAY_LEVEL_CONTENTS_BODY_ALL. Any combination of the following values can also be used.
    ObjectBrowserTabOMDTransform.DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS,
    ObjectBrowserTabOMDTransform.DISPLAY_LEVEL_CONTENTS_BODY_LIST,
    ObjectBrowserTabOMDTransform.DISPLAY_LEVEL_CONTENTS_BODY_SEARCH,
    ObjectBrowserTabOMDTransform.DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH
    metricDmxImage STRING metricDmx.gif false Indicates the image to use when displaying a Predictive metric.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    metricImage STRING metric.png false Indicates the image to use when displaying a metric.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    navigateOnSubmit BOOLEAN false false Indicates if the editor will move to a new page after the user clicks on the OK button
    objectSubtypesFilter STRING   false Indicates the filter specification for the object subtypes that should not be displayed.
    This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
    The value to specify for this formal parameter should be a list of numeric object subtypes, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "257,769", indicates custom groups (EnumDSSXMLObjectSubTypes.DssXmlSubTypeCustomGroup) and graphs EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportGraph) should not be displayed if found on the collection of objects to display.
    objectTypesFilter STRING   false Indicates the filter specification for the object types that should not be displayed.
    This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
    The value to specify for this formal parameter should be a list of numeric object types, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "3,4", indicates reports (EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition) and metrics EnumDSSXMLObjectTypes.DssXmlTypeMetric) should not be displayed if found on the collection of objects to display.
    okJS STRING   false Indicates JavaScript functionality to be invoked when 'OK' buttons is pressed.
    JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
    If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
    okLabel STRING   false Indicates the OK label when no title id is provided.
    okLabelID STRING mstrWeb.1442 false Indicates the OK label id according to the application's resource buldles.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    promptImage STRING prompt.png false Indicates the image to use when displaying a prompt.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    raImage STRING Attribute.gif false  
    renderForm BOOLEAN false false Indicates whether the editor will create its own form.
    reportImage STRING report2.gif false Indicates the image to use when displaying a report.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    titleLabel STRING   false Indicates the title when no title id is provided.
    titleLabelID STRING   false Indicates the title id according to the application's resource buldles.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.